<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>ConcurrentMapResourceOrganizer xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/com/cerner/system/rest/resource/organizer/ConcurrentMapResourceOrganizer.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_javadoccomment">/**</em>
<a name="2" href="#2">2</a>   <em class="jxr_javadoccomment"> * Copyright (c) 2009 Cerner Corporation.</em>
<a name="3" href="#3">3</a>   <em class="jxr_javadoccomment"> * All rights reserved. This program and the accompanying materials</em>
<a name="4" href="#4">4</a>   <em class="jxr_javadoccomment"> * are made available under the terms of the Eclipse Public License v1.0</em>
<a name="5" href="#5">5</a>   <em class="jxr_javadoccomment"> * which accompanies this distribution, and is available at</em>
<a name="6" href="#6">6</a>   <em class="jxr_javadoccomment"> * <a href="http://www.eclipse.org/legal/epl-v10.html" target="alexandria_uri">http://www.eclipse.org/legal/epl-v10.html</a></em>
<a name="7" href="#7">7</a>   <em class="jxr_javadoccomment"> *</em>
<a name="8" href="#8">8</a>   <em class="jxr_javadoccomment"> * Contributors:</em>
<a name="9" href="#9">9</a>   <em class="jxr_javadoccomment"> *    Cerner Corporation - initial API and implementation</em>
<a name="10" href="#10">10</a>  <em class="jxr_javadoccomment"> */</em>
<a name="11" href="#11">11</a>  <strong class="jxr_keyword">package</strong> com.cerner.system.<strong class="jxr_keyword">rest</strong>.resource.organizer;
<a name="12" href="#12">12</a>  
<a name="13" href="#13">13</a>  <strong class="jxr_keyword">import</strong> java.net.URI;
<a name="14" href="#14">14</a>  <strong class="jxr_keyword">import</strong> java.util.concurrent.locks.Lock;
<a name="15" href="#15">15</a>  <strong class="jxr_keyword">import</strong> java.util.concurrent.locks.ReadWriteLock;
<a name="16" href="#16">16</a>  <strong class="jxr_keyword">import</strong> java.util.concurrent.locks.ReentrantReadWriteLock;
<a name="17" href="#17">17</a>  
<a name="18" href="#18">18</a>  <strong class="jxr_keyword">import</strong> com.cerner.system.<strong class="jxr_keyword">rest</strong>.resource.organizer.spi.ResourceKey;
<a name="19" href="#19">19</a>  <strong class="jxr_keyword">import</strong> com.cerner.system.<strong class="jxr_keyword">rest</strong>.resource.organizer.spi.ThreadSafe;
<a name="20" href="#20">20</a>  
<a name="21" href="#21">21</a>  <em class="jxr_javadoccomment">/**</em>
<a name="22" href="#22">22</a>  <em class="jxr_javadoccomment"> * Thread-safe {@link ResourceOrganizer} implementation that allows for the</em>
<a name="23" href="#23">23</a>  <em class="jxr_javadoccomment"> * organization of resources in a hierarchical tree structure maintained by a</em>
<a name="24" href="#24">24</a>  <em class="jxr_javadoccomment"> * {@link java.util.Map} data structure.</em>
<a name="25" href="#25">25</a>  <em class="jxr_javadoccomment"> * </em>
<a name="26" href="#26">26</a>  <em class="jxr_javadoccomment"> * @author Alex Horn</em>
<a name="27" href="#27">27</a>  <em class="jxr_javadoccomment"> * @param &lt;E&gt; class type of objects that should be cached</em>
<a name="28" href="#28">28</a>  <em class="jxr_javadoccomment"> */</em>
<a name="29" href="#29">29</a>  @ThreadSafe
<a name="30" href="#30">30</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> ConcurrentMapResourceOrganizer&lt;E&gt; implements ResourceOrganizer&lt;E&gt; {
<a name="31" href="#31">31</a>  
<a name="32" href="#32">32</a>    <em class="jxr_javadoccomment">/**</em>
<a name="33" href="#33">33</a>  <em class="jxr_javadoccomment">   * Components that would like to read from or write to the map must acquire</em>
<a name="34" href="#34">34</a>  <em class="jxr_javadoccomment">   * the appropriate lock via {@link #getReadLock()} and {@link #getWriteLock()}</em>
<a name="35" href="#35">35</a>  <em class="jxr_javadoccomment">   * .</em>
<a name="36" href="#36">36</a>  <em class="jxr_javadoccomment">   */</em>
<a name="37" href="#37">37</a>    <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> MapResourceOrganizer&lt;E&gt; organizer;
<a name="38" href="#38">38</a>  
<a name="39" href="#39">39</a>    <em class="jxr_javadoccomment">/**</em>
<a name="40" href="#40">40</a>  <em class="jxr_javadoccomment">   * Reentrant read-write lock that protects the {@link #organizer} data</em>
<a name="41" href="#41">41</a>  <em class="jxr_javadoccomment">   * structure.</em>
<a name="42" href="#42">42</a>  <em class="jxr_javadoccomment">   */</em>
<a name="43" href="#43">43</a>    <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> ReadWriteLock organizerLock;
<a name="44" href="#44">44</a>  
<a name="45" href="#45">45</a>    <em class="jxr_javadoccomment">/**</em>
<a name="46" href="#46">46</a>  <em class="jxr_javadoccomment">   * Instantiate a thread-safe {@link ResourceOrganizer} object that stores</em>
<a name="47" href="#47">47</a>  <em class="jxr_javadoccomment">   * resources as entries in an in-memory {@link java.util.Map} data structure.</em>
<a name="48" href="#48">48</a>  <em class="jxr_javadoccomment">   * &lt;p&gt;</em>
<a name="49" href="#49">49</a>  <em class="jxr_javadoccomment">   * The base URI is used to {@link #resource(java.net.URI) resolve} resource</em>
<a name="50" href="#50">50</a>  <em class="jxr_javadoccomment">   * URIs.</em>
<a name="51" href="#51">51</a>  <em class="jxr_javadoccomment">   * </em>
<a name="52" href="#52">52</a>  <em class="jxr_javadoccomment">   * @param baseURI base URI must conform to the &lt;a</em>
<a name="53" href="#53">53</a>  <em class="jxr_javadoccomment">   *          href="<a href="http://tools.ietf.org/html/rfc3986" target="alexandria_uri">http://tools.ietf.org/html/rfc3986</a>#section-4.3"</em>
<a name="54" href="#54">54</a>  <em class="jxr_javadoccomment">   *          &gt;&amp;lt;absolute-URI&amp;gt; syntax rule&lt;/a&gt;</em>
<a name="55" href="#55">55</a>  <em class="jxr_javadoccomment">   * @throws IllegalArgumentException if the base URI is {@code null} or it does</em>
<a name="56" href="#56">56</a>  <em class="jxr_javadoccomment">   *           not conform to the &lt;a</em>
<a name="57" href="#57">57</a>  <em class="jxr_javadoccomment">   *           href="<a href="http://tools.ietf.org/html/rfc3986" target="alexandria_uri">http://tools.ietf.org/html/rfc3986</a>#section-4.3"</em>
<a name="58" href="#58">58</a>  <em class="jxr_javadoccomment">   *           &gt;&amp;lt;absolute-URI&amp;gt; syntax rule&lt;/a&gt;</em>
<a name="59" href="#59">59</a>  <em class="jxr_javadoccomment">   */</em>
<a name="60" href="#60">60</a>    <strong class="jxr_keyword">public</strong> <a href="../../../../../../com/cerner/system/rest/resource/organizer/ConcurrentMapResourceOrganizer.html">ConcurrentMapResourceOrganizer</a>(<strong class="jxr_keyword">final</strong> java.net.URI baseURI) {
<a name="61" href="#61">61</a>      <strong class="jxr_keyword">this</strong>.organizer = <strong class="jxr_keyword">new</strong> MapResourceOrganizer&lt;E&gt;(baseURI);
<a name="62" href="#62">62</a>      <strong class="jxr_keyword">this</strong>.organizerLock = <strong class="jxr_keyword">new</strong> ReentrantReadWriteLock();
<a name="63" href="#63">63</a>    }
<a name="64" href="#64">64</a>  
<a name="65" href="#65">65</a>    <em class="jxr_comment">/*</em>
<a name="66" href="#66">66</a>  <em class="jxr_comment">   * Write lock acquisition on map data structure</em>
<a name="67" href="#67">67</a>  <em class="jxr_comment">   */</em>
<a name="68" href="#68">68</a>    <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> clear() {
<a name="69" href="#69">69</a>      <strong class="jxr_keyword">final</strong> Lock writeLock = getWriteLock();
<a name="70" href="#70">70</a>      writeLock.lock();
<a name="71" href="#71">71</a>      <strong class="jxr_keyword">try</strong> {
<a name="72" href="#72">72</a>        <strong class="jxr_keyword">this</strong>.organizer.clear();
<a name="73" href="#73">73</a>      } <strong class="jxr_keyword">finally</strong> {
<a name="74" href="#74">74</a>        writeLock.unlock();
<a name="75" href="#75">75</a>      }
<a name="76" href="#76">76</a>    }
<a name="77" href="#77">77</a>  
<a name="78" href="#78">78</a>    <em class="jxr_comment">/*</em>
<a name="79" href="#79">79</a>  <em class="jxr_comment">   * No lock acquisition</em>
<a name="80" href="#80">80</a>  <em class="jxr_comment">   */</em>
<a name="81" href="#81">81</a>    <strong class="jxr_keyword">public</strong> URI baseURI() {
<a name="82" href="#82">82</a>      <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.organizer.baseURI();
<a name="83" href="#83">83</a>    }
<a name="84" href="#84">84</a>  
<a name="85" href="#85">85</a>    <em class="jxr_comment">/*</em>
<a name="86" href="#86">86</a>  <em class="jxr_comment">   * No lock acquisition</em>
<a name="87" href="#87">87</a>  <em class="jxr_comment">   */</em>
<a name="88" href="#88">88</a>    <strong class="jxr_keyword">public</strong> ConcurrentMapResourceController&lt;E&gt; resource(<strong class="jxr_keyword">final</strong> java.net.URI uri) {
<a name="89" href="#89">89</a>      <strong class="jxr_keyword">final</strong> <a href="../../../../../../com/cerner/system/rest/resource/organizer/spi/ResourceKey.html">ResourceKey</a> key = <strong class="jxr_keyword">new</strong> <a href="../../../../../../com/cerner/system/rest/resource/organizer/spi/ResourceKey.html">ResourceKey</a>(baseURI(), uri);
<a name="90" href="#90">90</a>      <strong class="jxr_keyword">final</strong> MapResourceController&lt;E&gt; controller = <strong class="jxr_keyword">new</strong> MapResourceController&lt;E&gt;(
<a name="91" href="#91">91</a>          key, <strong class="jxr_keyword">this</strong>.organizer);
<a name="92" href="#92">92</a>  
<a name="93" href="#93">93</a>      <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> ConcurrentMapResourceController&lt;E&gt;(controller, <strong class="jxr_keyword">this</strong>);
<a name="94" href="#94">94</a>    }
<a name="95" href="#95">95</a>  
<a name="96" href="#96">96</a>    <em class="jxr_javadoccomment">/**</em>
<a name="97" href="#97">97</a>  <em class="jxr_javadoccomment">   * Obtain a read lock on the underlying map data structure.</em>
<a name="98" href="#98">98</a>  <em class="jxr_javadoccomment">   * </em>
<a name="99" href="#99">99</a>  <em class="jxr_javadoccomment">   * @return read lock</em>
<a name="100" href="#100">100</a> <em class="jxr_javadoccomment">   */</em>
<a name="101" href="#101">101</a>   <strong class="jxr_keyword">public</strong> Lock getReadLock() {
<a name="102" href="#102">102</a>     <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.organizerLock.readLock();
<a name="103" href="#103">103</a>   }
<a name="104" href="#104">104</a> 
<a name="105" href="#105">105</a>   <em class="jxr_javadoccomment">/**</em>
<a name="106" href="#106">106</a> <em class="jxr_javadoccomment">   * Obtain a write lock on the underlying map data structure.</em>
<a name="107" href="#107">107</a> <em class="jxr_javadoccomment">   * </em>
<a name="108" href="#108">108</a> <em class="jxr_javadoccomment">   * @return write lock</em>
<a name="109" href="#109">109</a> <em class="jxr_javadoccomment">   */</em>
<a name="110" href="#110">110</a>   <strong class="jxr_keyword">public</strong> Lock getWriteLock() {
<a name="111" href="#111">111</a>     <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.organizerLock.writeLock();
<a name="112" href="#112">112</a>   }
<a name="113" href="#113">113</a> 
<a name="114" href="#114">114</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

